

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <title>Conventions on naming tables and their columns &mdash; geoslurp v1.1.0 documentation</title>
  

  
  
    <link rel="shortcut icon" href="_static/favicon.ico"/>
  
  
  

  

  
  
    

  

  
  
    <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  

  

  
        <link rel="index" title="Index"
              href="genindex.html"/>
        <link rel="search" title="Search" href="search.html"/>
    <link rel="top" title="geoslurp v1.1.0 documentation" href="index.html"/>
        <link rel="up" title="Reference Documentation" href="reference.html"/>
        <link rel="next" title="Command line tools" href="clitools.html"/>
        <link rel="prev" title="Reference Documentation" href="reference.html"/> 

  
  <script src="_static/js/modernizr.min.js"></script>

</head>

<body class="wy-body-for-nav" role="document">

   
  <div class="wy-grid-for-nav">

    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search">
          

          
            <a href="index.html" class="icon icon-home"> geoslurp
          

          
          </a>

          
            
            
              <div class="version">
                1.1.0
              </div>
            
          

          
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>

          
        </div>

        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
          
            
            
              
            
            
              <p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="introduction.html">An introduction to Geoslurp</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation of the geoslurp package and setting up the PostgreSQL instance</a></li>
<li class="toctree-l1"><a class="reference internal" href="confsettings.html">Configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="examples.html">Tutorial</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="reference.html">Reference Documentation</a><ul class="current">
<li class="toctree-l2 current"><a class="current reference internal" href="#">Conventions on naming tables and their  columns</a></li>
<li class="toctree-l2"><a class="reference internal" href="clitools.html">Command line tools</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/geoslurp.html">geoslurp package</a></li>
</ul>
</li>
</ul>

            
          
        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
        
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="index.html">geoslurp</a>
        
      </nav>


      
      <div class="wy-nav-content">
        <div class="rst-content">
          















<div role="navigation" aria-label="breadcrumbs navigation">

  <ul class="wy-breadcrumbs">
    
      <li><a href="index.html">Docs</a> &raquo;</li>
        
          <li><a href="reference.html">Reference Documentation</a> &raquo;</li>
        
      <li>Conventions on naming tables and their  columns</li>
    
    
      <li class="wy-breadcrumbs-aside">
        
            
            <a href="_sources/tableconventions.rst.txt" rel="nofollow"> View page source</a>
          
        
      </li>
    
  </ul>

  
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            
  
<style>
/* CSS overrides for sphinx_rtd_theme */

/* 24px margin */
.nbinput.nblast,
.nboutput.nblast {
    margin-bottom: 19px;  /* padding has already 5px */
}

/* ... except between code cells! */
.nblast + .nbinput {
    margin-top: -19px;
}

.admonition > p:before {
    margin-right: 4px;  /* make room for the exclamation icon */
}
</style>
<div class="section" id="conventions-on-naming-tables-and-their-columns">
<span id="tablecols"></span><h1>Conventions on naming tables and their  columns<a class="headerlink" href="#conventions-on-naming-tables-and-their-columns" title="Permalink to this headline">¶</a></h1>
<p>Tables and schemes are/should be named in lowercase notation where ‘_’ can be used as separators.</p>
<p>The names of the columns are in principle free to choose, but an adherence to often-used columns according to the convention below is desired.</p>
<p><strong>geoslurp column naming conventions</strong></p>
<table border="1" class="docutils">
<colgroup>
<col width="16%" />
<col width="17%" />
<col width="67%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">name</th>
<th class="head">PostGreSQL type</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>uri</td>
<td>TEXT</td>
<td><div class="first last line-block">
<div class="line">Unified resource identifier. This holds the location of the datafile</div>
<div class="line">It is usually a file name, but can also be an hyperlink</div>
</div>
</td>
</tr>
<tr class="row-odd"><td>name</td>
<td>TEXT</td>
<td>Unique shortname which identifies the entry in a row</td>
</tr>
<tr class="row-even"><td>time</td>
<td><div class="first last line-block">
<div class="line">TIMESTAMP or</div>
<div class="line">ARRAY(TIMESTAMP)</div>
</div>
</td>
<td><div class="first last line-block">
<div class="line">Epoch relevant to the data row this may also be an array of</div>
<div class="line">timestamps</div>
</div>
</td>
</tr>
<tr class="row-odd"><td>geom</td>
<td>POSTGIS geometry</td>
<td><div class="first last line-block">
<div class="line">Holds the geometry object which can be understood by</div>
<div class="line">PostGIS</div>
</div>
</td>
</tr>
<tr class="row-even"><td>rast</td>
<td>POSTGIS raster</td>
<td>Holds the raster object which can be understood by PostGIS</td>
</tr>
<tr class="row-odd"><td>data</td>
<td>JSONB</td>
<td>Holds auxiliary data in the form of a json object</td>
</tr>
</tbody>
</table>
</div>


           </div>
           <div class="articleComments">
            
           </div>
          </div>
          <footer>
  
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
      
        <a href="clitools.html" class="btn btn-neutral float-right" title="Command line tools" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
      
      
        <a href="reference.html" class="btn btn-neutral" title="Reference Documentation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
      
    </div>
  

  <hr/>

  <div role="contentinfo">
    <p>
        &copy; Copyright 2020, Roelof Rietbroek.

    </p>
  </div>
  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. 

</footer>

        </div>
      </div>

    </section>

  </div>
  


  

    <script type="text/javascript">
        var DOCUMENTATION_OPTIONS = {
            URL_ROOT:'./',
            VERSION:'v1.1.0',
            COLLAPSE_INDEX:false,
            FILE_SUFFIX:'.html',
            HAS_SOURCE:  true,
            SOURCELINK_SUFFIX: '.txt'
        };
    </script>
      <script type="text/javascript" src="_static/jquery.js"></script>
      <script type="text/javascript" src="_static/underscore.js"></script>
      <script type="text/javascript" src="_static/doctools.js"></script>

  

  
  
    <script type="text/javascript" src="_static/js/theme.js"></script>
  

  
  
  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.StickyNav.enable();
      });
  </script>
   

</body>
</html>